Skip to content

Readme renewal#216

Open
smclacke wants to merge 14 commits intomainfrom
readme-renewal
Open

Readme renewal#216
smclacke wants to merge 14 commits intomainfrom
readme-renewal

Conversation

@smclacke
Copy link
Copy Markdown

@smclacke smclacke commented Apr 21, 2026

  • added extra link to licensing information for cheerpx.io/licensing
  • decided to leave the rest of the licensing section as is
  • cleaned up section about Claude AI, removing verbose screenshots
  • added Feature header and fixed TOC Feature header link
  • removed REPL diff block, created simple tip section and removed link from TOC

** this was branched from Merlin's 'readme-restructure' branch, which he will leave a comment about, giving details about the changes he has made.

(hi Merlin here --v)

Original branch changes

This PR and branch was build of off the documentations made prior by me in the branch readme_restructure. Changes made were:

  • Restructured and organized the different sections around user intent (quick start ->networking etc.) The original readme topics bled into each other, this separation should add clarity.

    • Broke down Networking into clear subsections
  • Reworded and restyled certain sections for added clarity (ie: merging the delay and connection status dot colour bullet points check into 1 concise tip)

  • Reworked local setup to a cleaner local serving flow.

    • Already included a custom-images directory and location block to save the user on setup steps. As well as adding clearer inline comments

@codingfrog27
Copy link
Copy Markdown
Contributor

codingfrog27 commented Apr 24, 2026

Looks good! The Claude AI section seems improved now! I've left comments on specific lines with changes. Besides these I'll lay out the further steps:

  • Fix image issue:

  • See if we can get mini image to work with sudo in local hosting. If not upload large image

  • test online deployment image again

  • test and if needed and possible fix mini image dockerfile (but if this would take too much time we leave it be)

  • Merge Alpine repo into this one

  • Bundle tips into connection tips section

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants